SignalResource
Description
call the SignalResource interface to send a signal.
Request Method
POST
Request Path
/apsara/route/ROS/SignalResource
Request Parameters Common Parameters
Name | Location | Type | Required | Sample value | Description |
---|---|---|---|---|---|
Status | BODY | string | Yes | SUCCESS | the state of the signal. Failure signals will cause the resource stack to be unable to be created or updated. If all signals are warning signals, the resource stack cannot be created or updated. Value: SUCCESS FAILURE WARNING |
UniqueId | BODY | string | Yes | 27c7347b-352a-4377-accf-63d361c1**** | unique ID of the signal. The length is 1 to 64 characters. If multiple signals are sent to a single resource (for example: signaling the waiting condition), each signal requires a different information ID. |
LogicalResourceId | BODY | string | Yes | WebServer | resource logical ID, that is, the name of the resource in the template. |
regionId | BODY | string | Yes | No sample value for this parameter. | region id |
RegionId | BODY | string | Yes | cn-hangzhou | the region ID to which the resource stack belongs. |
ClientToken | BODY | string | No | 123e4567-e89b-12d3-a456-42665544**** | guarantees the idempotence of the request. This value is generated by the client and must be globally unique. is up to 64 characters in length and can contain English letters, numbers, dashes (-) and underscores (_). |
version | BODY | string | No | 2016-01-01 | version of api |
StackId | BODY | string | Yes | 4a6c9851-3b0f-4f5f-b4ca-a14bf691**** | resource stack ID. |
Return data
Name | Type | Sample value | Description |
---|---|---|---|
RequestID | string | 1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC | Request id |
Example
Successful Response example
{
"RequestID":"1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC"
}
Failed Response example
{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}
}